HL7 FHIR Implementation Guide: ZM-Core Release 1 - Zambia
​0.1.0 - Zambia flag

HL7 FHIR Implementation Guide: ZM-Core Release 1 - Zambia - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: ZM-Core Communication Consent Profile

Official URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-communication-consent Version: 0.1.0
Active as of 2026-08-12 Computable Name: ZMCoreCommunicationConsent

An individual's consent decision governing whether and through which channels the Unified Health Communication Hub may make contact.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and their representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent 0..* Consent A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:channel S 1..* CodeableConcept Consent Communication Channel
URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-consent-communication-channel
Binding: Zambia Communication Channel Value Set (required)
... identifier SΣ 1..* Identifier Identifier for this record (external references)
... status ?!SΣ 1..1 code draft | active | inactive | not-done | entered-in-error | unknown
Binding: ConsentState (required): Indicates the state of the consent.
... category SΣ 1..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (example): A classification of the type of consents found in a consent statement.
... subject SΣ 1..1 Reference(ZM-Core Patient Profile) Who the consent applies to
... date SΣ 1..1 date Fully executed date of the consent
... period SΣ 0..1 Period Effective period for this Consent
... grantor SΣ 0..* Reference(CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is granting rights according to the policy and rules
... grantee SΣ 0..* Reference(CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is agreeing to the policy and rules
... manager S 0..* Reference(HealthcareService | Organization | Patient | Practitioner) Consent workflow management
... controller S 0..* Reference(HealthcareService | Organization | Patient | Practitioner) Consent Enforcer
... sourceAttachment S 0..* Attachment Source from which this consent is taken
... sourceReference S 0..* Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) Source from which this consent is taken
... regulatoryBasis S 0..* CodeableConcept Regulations establishing base Consent
Binding: ConsentPolicyRuleCodes (example): Regulatory policy examples
... policyBasis S 0..1 BackboneElement Computable version of the backing policy
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
... policyText S 0..* Reference(DocumentReference) Human Readable Policy
... verification SΣ 0..* BackboneElement Consent Verified by patient or family
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... verified Σ 1..1 boolean Has been verified
... decision ?!SΣ 1..1 code deny | permit
Binding: ConsentProvisionType (required): Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level.
... provision SΣ 1..* BackboneElement Constraints to the base Consent.policyRule/Consent.policy
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... period SΣ 0..1 Period Timeframe for this provision
.... action SΣ 1..* CodeableConcept Actions controlled by this provision
Binding: Zambia Communication Consent Action Value Set (required)
.... securityLabel SΣ 0..* Coding Security Labels that define affected resources
Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
.... purpose SΣ 0..* Coding Context of activities covered by this provision
Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.
.... dataPeriod SΣ 0..1 Period Timeframe for data controlled by this provision

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.status Base required Consent State 📍5.0.0 FHIR Std.
Consent.category Base example Consent Category Codes 📍5.0.0 FHIR Std.
Consent.regulatoryBasis Base example Consent PolicyRule Codes 📍5.0.0 FHIR Std.
Consent.decision Base required Consent Provision Type 📍5.0.0 FHIR Std.
Consent.provision.action Base required Zambia Communication Consent Action Value Set 📦0.1.0 This IG
Consent.provision.securityLabel Base example Example set of Security Labels 📍5.0.0 FHIR Std.
Consent.provision.purpose Base extensible PurposeOfUse 📦3.1.0 THO v7.1

Constraints

Id Grade Path(s) Description Expression
dom-2 error Consent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Consent If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Consent If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Consent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Consent A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent 0..* Consent A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:channel S 1..* CodeableConcept Consent Communication Channel
URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-consent-communication-channel
Binding: Zambia Communication Channel Value Set (required)
... identifier S 1..* Identifier Identifier for this record (external references)
... status S 1..1 code draft | active | inactive | not-done | entered-in-error | unknown
... subject S 1..1 Reference(ZM-Core Patient Profile) Who the consent applies to
... date S 1..1 date Fully executed date of the consent
... period S 0..1 Period Effective period for this Consent
... grantor S 0..* Reference(CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is granting rights according to the policy and rules
... grantee S 0..* Reference(CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is agreeing to the policy and rules
... manager S 0..* Reference(HealthcareService | Organization | Patient | Practitioner) Consent workflow management
... controller S 0..* Reference(HealthcareService | Organization | Patient | Practitioner) Consent Enforcer
... sourceAttachment S 0..* Attachment Source from which this consent is taken
... sourceReference S 0..* Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) Source from which this consent is taken
... regulatoryBasis S 0..* CodeableConcept Regulations establishing base Consent
... policyBasis S 0..1 BackboneElement Computable version of the backing policy
... policyText S 0..* Reference(DocumentReference) Human Readable Policy
... verification S 0..* BackboneElement Consent Verified by patient or family
... decision S 1..1 code deny | permit
... provision S 1..* BackboneElement Constraints to the base Consent.policyRule/Consent.policy
.... period S 0..1 Period Timeframe for this provision
.... action S 1..* CodeableConcept Actions controlled by this provision
Binding: Zambia Communication Consent Action Value Set (required)
.... securityLabel S 0..* Coding Security Labels that define affected resources
.... purpose S 0..* Coding Context of activities covered by this provision
.... dataPeriod S 0..1 Period Timeframe for data controlled by this provision

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Consent.provision.action Base required Zambia Communication Consent Action Value Set 📦0.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent 0..* Consent A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:channel S 1..* CodeableConcept Consent Communication Channel
URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-consent-communication-channel
Binding: Zambia Communication Channel Value Set (required)
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier Identifier for this record (external references)
... status ?!SΣ 1..1 code draft | active | inactive | not-done | entered-in-error | unknown
Binding: ConsentState (required): Indicates the state of the consent.
... category SΣ 1..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (example): A classification of the type of consents found in a consent statement.
... subject SΣ 1..1 Reference(ZM-Core Patient Profile) Who the consent applies to
... date SΣ 1..1 date Fully executed date of the consent
... period SΣ 0..1 Period Effective period for this Consent
... grantor SΣ 0..* Reference(CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is granting rights according to the policy and rules
... grantee SΣ 0..* Reference(CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is agreeing to the policy and rules
... manager S 0..* Reference(HealthcareService | Organization | Patient | Practitioner) Consent workflow management
... controller S 0..* Reference(HealthcareService | Organization | Patient | Practitioner) Consent Enforcer
... sourceAttachment S 0..* Attachment Source from which this consent is taken
... sourceReference S 0..* Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) Source from which this consent is taken
... regulatoryBasis S 0..* CodeableConcept Regulations establishing base Consent
Binding: ConsentPolicyRuleCodes (example): Regulatory policy examples
... policyBasis S 0..1 BackboneElement Computable version of the backing policy
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... reference 0..1 Reference(Resource) Reference backing policy resource
.... url 0..1 url URL to a computable backing policy
... policyText S 0..* Reference(DocumentReference) Human Readable Policy
... verification SΣ 0..* BackboneElement Consent Verified by patient or family
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... verified Σ 1..1 boolean Has been verified
.... verificationType 0..1 CodeableConcept Business case of verification
Binding: ConsentVerificationCodes (example): Types of Verification/Validation.
.... verifiedBy 0..1 Reference(Organization | Practitioner | PractitionerRole) Person conducting verification
.... verifiedWith 0..1 Reference(Patient | RelatedPerson) Person who verified
.... verificationDate 0..* dateTime When consent verified
... decision ?!SΣ 1..1 code deny | permit
Binding: ConsentProvisionType (required): Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level.
... provision SΣ 1..* BackboneElement Constraints to the base Consent.policyRule/Consent.policy
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... period SΣ 0..1 Period Timeframe for this provision
.... actor 0..* BackboneElement Who|what controlled by this provision (or group, by role)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... role 0..1 CodeableConcept How the actor is involved
Binding: ParticipationRoleType (extensible): How an actor is involved in the consent considerations.
..... reference 0..1 Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Resource for the actor (or group, by role)
.... action SΣ 1..* CodeableConcept Actions controlled by this provision
Binding: Zambia Communication Consent Action Value Set (required)
.... securityLabel SΣ 0..* Coding Security Labels that define affected resources
Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
.... purpose SΣ 0..* Coding Context of activities covered by this provision
Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.
.... documentType Σ 0..* Coding e.g. Resource Type, Profile, CDA, etc
Binding: ConsentContentClass (preferred): The document type a consent provision covers.
.... resourceType Σ 0..* Coding e.g. Resource Type, Profile, etc
Binding: ResourceType (extensible): The resource types a consent provision covers.
.... code Σ 0..* CodeableConcept e.g. LOINC or SNOMED CT code, etc. in the content
Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies.
.... dataPeriod SΣ 0..1 Period Timeframe for data controlled by this provision
.... data Σ 0..* BackboneElement Data controlled by this provision
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... meaning Σ 1..1 code instance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
..... reference Σ 1..1 Reference(Resource) The actual data reference
.... expression 0..1 Expression A computable expression of the consent
.... provision 0..* See provision (Consent) Nested Exception Provisions

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.language Base required All Languages 📍5.0.0 FHIR Std.
Consent.status Base required Consent State 📍5.0.0 FHIR Std.
Consent.category Base example Consent Category Codes 📍5.0.0 FHIR Std.
Consent.regulatoryBasis Base example Consent PolicyRule Codes 📍5.0.0 FHIR Std.
Consent.verification.​verificationType Base example Consent Vefication Codes 📍5.0.0 FHIR Std.
Consent.decision Base required Consent Provision Type 📍5.0.0 FHIR Std.
Consent.provision.actor.​role Base extensible Participation Role Type 📍5.0.0 FHIR Std.
Consent.provision.action Base required Zambia Communication Consent Action Value Set 📦0.1.0 This IG
Consent.provision.securityLabel Base example Example set of Security Labels 📍5.0.0 FHIR Std.
Consent.provision.purpose Base extensible PurposeOfUse 📦3.1.0 THO v7.1
Consent.provision.documentType Base preferred Consent Content Class 📍5.0.0 FHIR Std.
Consent.provision.resourceType Base extensible Resource Types 📍5.0.0 FHIR Std.
Consent.provision.code Base example Consent Content Codes 📍5.0.0 FHIR Std.
Consent.provision.data.​meaning Base required Consent Data Meaning 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Consent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Consent If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Consent If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Consent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Consent A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Mandatory: 9 elements
Must-Support: 24 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent 0..* Consent A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:channel S 1..* CodeableConcept Consent Communication Channel
URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-consent-communication-channel
Binding: Zambia Communication Channel Value Set (required)
... identifier SΣ 1..* Identifier Identifier for this record (external references)
... status ?!SΣ 1..1 code draft | active | inactive | not-done | entered-in-error | unknown
Binding: ConsentState (required): Indicates the state of the consent.
... category SΣ 1..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (example): A classification of the type of consents found in a consent statement.
... subject SΣ 1..1 Reference(ZM-Core Patient Profile) Who the consent applies to
... date SΣ 1..1 date Fully executed date of the consent
... period SΣ 0..1 Period Effective period for this Consent
... grantor SΣ 0..* Reference(CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is granting rights according to the policy and rules
... grantee SΣ 0..* Reference(CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is agreeing to the policy and rules
... manager S 0..* Reference(HealthcareService | Organization | Patient | Practitioner) Consent workflow management
... controller S 0..* Reference(HealthcareService | Organization | Patient | Practitioner) Consent Enforcer
... sourceAttachment S 0..* Attachment Source from which this consent is taken
... sourceReference S 0..* Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) Source from which this consent is taken
... regulatoryBasis S 0..* CodeableConcept Regulations establishing base Consent
Binding: ConsentPolicyRuleCodes (example): Regulatory policy examples
... policyBasis S 0..1 BackboneElement Computable version of the backing policy
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
... policyText S 0..* Reference(DocumentReference) Human Readable Policy
... verification SΣ 0..* BackboneElement Consent Verified by patient or family
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... verified Σ 1..1 boolean Has been verified
... decision ?!SΣ 1..1 code deny | permit
Binding: ConsentProvisionType (required): Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level.
... provision SΣ 1..* BackboneElement Constraints to the base Consent.policyRule/Consent.policy
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... period SΣ 0..1 Period Timeframe for this provision
.... action SΣ 1..* CodeableConcept Actions controlled by this provision
Binding: Zambia Communication Consent Action Value Set (required)
.... securityLabel SΣ 0..* Coding Security Labels that define affected resources
Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
.... purpose SΣ 0..* Coding Context of activities covered by this provision
Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.
.... dataPeriod SΣ 0..1 Period Timeframe for data controlled by this provision

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.status Base required Consent State 📍5.0.0 FHIR Std.
Consent.category Base example Consent Category Codes 📍5.0.0 FHIR Std.
Consent.regulatoryBasis Base example Consent PolicyRule Codes 📍5.0.0 FHIR Std.
Consent.decision Base required Consent Provision Type 📍5.0.0 FHIR Std.
Consent.provision.action Base required Zambia Communication Consent Action Value Set 📦0.1.0 This IG
Consent.provision.securityLabel Base example Example set of Security Labels 📍5.0.0 FHIR Std.
Consent.provision.purpose Base extensible PurposeOfUse 📦3.1.0 THO v7.1

Constraints

Id Grade Path(s) Description Expression
dom-2 error Consent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Consent If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Consent If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Consent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Consent A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent 0..* Consent A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:channel S 1..* CodeableConcept Consent Communication Channel
URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-consent-communication-channel
Binding: Zambia Communication Channel Value Set (required)
... identifier S 1..* Identifier Identifier for this record (external references)
... status S 1..1 code draft | active | inactive | not-done | entered-in-error | unknown
... subject S 1..1 Reference(ZM-Core Patient Profile) Who the consent applies to
... date S 1..1 date Fully executed date of the consent
... period S 0..1 Period Effective period for this Consent
... grantor S 0..* Reference(CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is granting rights according to the policy and rules
... grantee S 0..* Reference(CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is agreeing to the policy and rules
... manager S 0..* Reference(HealthcareService | Organization | Patient | Practitioner) Consent workflow management
... controller S 0..* Reference(HealthcareService | Organization | Patient | Practitioner) Consent Enforcer
... sourceAttachment S 0..* Attachment Source from which this consent is taken
... sourceReference S 0..* Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) Source from which this consent is taken
... regulatoryBasis S 0..* CodeableConcept Regulations establishing base Consent
... policyBasis S 0..1 BackboneElement Computable version of the backing policy
... policyText S 0..* Reference(DocumentReference) Human Readable Policy
... verification S 0..* BackboneElement Consent Verified by patient or family
... decision S 1..1 code deny | permit
... provision S 1..* BackboneElement Constraints to the base Consent.policyRule/Consent.policy
.... period S 0..1 Period Timeframe for this provision
.... action S 1..* CodeableConcept Actions controlled by this provision
Binding: Zambia Communication Consent Action Value Set (required)
.... securityLabel S 0..* Coding Security Labels that define affected resources
.... purpose S 0..* Coding Context of activities covered by this provision
.... dataPeriod S 0..1 Period Timeframe for data controlled by this provision

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Consent.provision.action Base required Zambia Communication Consent Action Value Set 📦0.1.0 This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent 0..* Consent A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:channel S 1..* CodeableConcept Consent Communication Channel
URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-consent-communication-channel
Binding: Zambia Communication Channel Value Set (required)
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier Identifier for this record (external references)
... status ?!SΣ 1..1 code draft | active | inactive | not-done | entered-in-error | unknown
Binding: ConsentState (required): Indicates the state of the consent.
... category SΣ 1..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (example): A classification of the type of consents found in a consent statement.
... subject SΣ 1..1 Reference(ZM-Core Patient Profile) Who the consent applies to
... date SΣ 1..1 date Fully executed date of the consent
... period SΣ 0..1 Period Effective period for this Consent
... grantor SΣ 0..* Reference(CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is granting rights according to the policy and rules
... grantee SΣ 0..* Reference(CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is agreeing to the policy and rules
... manager S 0..* Reference(HealthcareService | Organization | Patient | Practitioner) Consent workflow management
... controller S 0..* Reference(HealthcareService | Organization | Patient | Practitioner) Consent Enforcer
... sourceAttachment S 0..* Attachment Source from which this consent is taken
... sourceReference S 0..* Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) Source from which this consent is taken
... regulatoryBasis S 0..* CodeableConcept Regulations establishing base Consent
Binding: ConsentPolicyRuleCodes (example): Regulatory policy examples
... policyBasis S 0..1 BackboneElement Computable version of the backing policy
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... reference 0..1 Reference(Resource) Reference backing policy resource
.... url 0..1 url URL to a computable backing policy
... policyText S 0..* Reference(DocumentReference) Human Readable Policy
... verification SΣ 0..* BackboneElement Consent Verified by patient or family
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... verified Σ 1..1 boolean Has been verified
.... verificationType 0..1 CodeableConcept Business case of verification
Binding: ConsentVerificationCodes (example): Types of Verification/Validation.
.... verifiedBy 0..1 Reference(Organization | Practitioner | PractitionerRole) Person conducting verification
.... verifiedWith 0..1 Reference(Patient | RelatedPerson) Person who verified
.... verificationDate 0..* dateTime When consent verified
... decision ?!SΣ 1..1 code deny | permit
Binding: ConsentProvisionType (required): Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level.
... provision SΣ 1..* BackboneElement Constraints to the base Consent.policyRule/Consent.policy
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... period SΣ 0..1 Period Timeframe for this provision
.... actor 0..* BackboneElement Who|what controlled by this provision (or group, by role)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... role 0..1 CodeableConcept How the actor is involved
Binding: ParticipationRoleType (extensible): How an actor is involved in the consent considerations.
..... reference 0..1 Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Resource for the actor (or group, by role)
.... action SΣ 1..* CodeableConcept Actions controlled by this provision
Binding: Zambia Communication Consent Action Value Set (required)
.... securityLabel SΣ 0..* Coding Security Labels that define affected resources
Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
.... purpose SΣ 0..* Coding Context of activities covered by this provision
Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.
.... documentType Σ 0..* Coding e.g. Resource Type, Profile, CDA, etc
Binding: ConsentContentClass (preferred): The document type a consent provision covers.
.... resourceType Σ 0..* Coding e.g. Resource Type, Profile, etc
Binding: ResourceType (extensible): The resource types a consent provision covers.
.... code Σ 0..* CodeableConcept e.g. LOINC or SNOMED CT code, etc. in the content
Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies.
.... dataPeriod SΣ 0..1 Period Timeframe for data controlled by this provision
.... data Σ 0..* BackboneElement Data controlled by this provision
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... meaning Σ 1..1 code instance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
..... reference Σ 1..1 Reference(Resource) The actual data reference
.... expression 0..1 Expression A computable expression of the consent
.... provision 0..* See provision (Consent) Nested Exception Provisions

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.language Base required All Languages 📍5.0.0 FHIR Std.
Consent.status Base required Consent State 📍5.0.0 FHIR Std.
Consent.category Base example Consent Category Codes 📍5.0.0 FHIR Std.
Consent.regulatoryBasis Base example Consent PolicyRule Codes 📍5.0.0 FHIR Std.
Consent.verification.​verificationType Base example Consent Vefication Codes 📍5.0.0 FHIR Std.
Consent.decision Base required Consent Provision Type 📍5.0.0 FHIR Std.
Consent.provision.actor.​role Base extensible Participation Role Type 📍5.0.0 FHIR Std.
Consent.provision.action Base required Zambia Communication Consent Action Value Set 📦0.1.0 This IG
Consent.provision.securityLabel Base example Example set of Security Labels 📍5.0.0 FHIR Std.
Consent.provision.purpose Base extensible PurposeOfUse 📦3.1.0 THO v7.1
Consent.provision.documentType Base preferred Consent Content Class 📍5.0.0 FHIR Std.
Consent.provision.resourceType Base extensible Resource Types 📍5.0.0 FHIR Std.
Consent.provision.code Base example Consent Content Codes 📍5.0.0 FHIR Std.
Consent.provision.data.​meaning Base required Consent Data Meaning 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Consent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Consent If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Consent If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Consent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Consent A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Mandatory: 9 elements
Must-Support: 24 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron